User Guide
1 Introduction
The following document is a guide for students, teachers, and admins alike to guide users on how to create an account, log in, and use the features of our vet simulator.
2 Web Portal
2.1 Account Management
2.1.1 Sign-up
- Ask your administrator to register you into the system and provide them with your
full nameandemail address.- For university admins, please contact the super admin.
- For teachers, please contact your university admin.
- For students, please contact your teacher.
- Super admins will be given their credentials.
- Navigate to the sign-up page of our application.
Enter in your credentials:
- First Name (Must match what you provided with your admin.)
- Last Name (Must match what you provided with your admin.)
- Email (Must use university/clinic email if domain checking is turned on for your organization.)
- Password with the following requirements:
- Must be at minimum 8 characters long.
- Must NOT include your name.
- Must have at least one symbol and numeric character.
- Must have at least one capital and one lowercase character.
- Access Code for the organization.
- Click
Sign-up.
2.1.2 Login
- Navigate to the login page.
- Enter your email and password.
- Click
login.
2.2 Super Admin
The super-admin dashboard gives super admins the ability to create organizations and manage existing universities/clinics. They can also manage the global billing infostracuture for each of their clients and message them through the feedback system.
2.2.1 Dashboard
The super-admin dashboard page shows all currently enrolled existing organizations Each entry will show:
- Name
- The name of the organization
- Organization Type
-
The type of the organization (
University|Clinic)
- Number of Seats
- The number of seats purchased by the organization
2.2.1.1 Adding New Organizations
To add a create a new organization in the system 1. Click Add Organization on the top right hand corner of the screen 2. Enter in the following information for an organization: 1. Organization Name 2. The Organization Type - University - Clinic 3. The number of seats for that client 4. The subscription contract for that client 5. The organizations logo 6. The default primary and secondary colors for that organization 3. Click ADD
2.2.1.2 Editing an Organizations
To edit details of an existing organization such as the number of seats or contract 1. Click Details on the organization you would like to edit 2. Click Edit 3. Select the text of the detail you would like to edit 4. Enter the new value 5. Click Save 6. Dismiss the modal by clicking anywhere outside it
2.2.1.3 Deleting an Organization
There is currently NO confirmation for deletion of a organization. Please delete with caution. Once deleted all information linked with that organization will removed There is NO way to revive an deleted organization
To remove an organization from the system 1. Click Details on the organization you would like to remove 2. Click Delete Organization
2.3 University Admin
After signing in as a university admin, you will be brought to the primary dashboard for a university admin. You will be presented with 4 main managerial options.
2.3.1 Users
This page is to allow a university admin to view all teachers currently enrolled in a particular university.
Each entry will display the instructor’s name and the number of seats assigned to an instructor.
2.3.1.1 Adding to an Instructor
Click
+ Add Teacheron the top right-hand corner of the page.Enter in the following credentials for the instructor:
- Their first name.
- Their last name.
- Their email address. 1
- The number of seats for that instructor.
Click
Submit.
2.3.1.2 Removing an Instructor
There is currently NO confirmation for deletion of a teacher. Please delete with caution. Once deleted all information linked with that instructor will removed There is NO way to revive an deleted instructor
Scroll to the row with the instructor you would like to remove.
Click the trash on the row of the instructor.
2.3.2 Billing
The billing tab allows a university admin to manage the university billing history and options.
2.3.2.1 Subscription Details
Highlights the current enrolled plan, the number of seats provided for the plan, the cost for a yearly subscription, and when the subscription ends.
2.3.2.2 Payment Method
This section indicates the current payment method used for paying for the subscription. This card will be used for purchasing additional seats or auto-renewal once those features are implemented.
2.3.2.3 Invoice History
Displays the past payment history for this university, such as previous year subscription costs and the number of seats purchased for that subscription.
2.3.3 Domains
While the frontend implementation of this feature has been implemented, the backend part is not. Therefore, this rule is not enforced.
This page allows the university admins to turn on and off domain checking.
Each row will display the domain and whether it’s allowed in this organization.
2.3.4 Seats
This page will show the total number of seats purchased by the organization and the number of open seats available for students.
2.3.5 Feedback
Please refer to student-feedback for backend status of this feature
This tab allows a university admin to view feedback from students and teachers in the organization. On the top, you can view the total number of teachers, students, and comments posted in the university.
The feedback table provides an overview of the latest feedback from students and teachers.
2.3.5.1 Columns of the Feedback Table
- Name:
- Name of the user who posted the feedback.
- Role:
- Role of the user who posted the feedback.
- Comment:
- Message of the feedback.
- Simulation:
- The simulation this ticket is related to.
2.3.6 Questions
Only, the university side of this feature has been implemented. there is currently no way for super-admins to view the questions posted on this page.
The question page allows university admins to contact the super admin for any questions or concerns they may have.
To submit a message to a super-admin
- Type in the message you would like to send to the super-admin.
- Select an urgency level to mark the message as:
- Low
- The request is of low priory such as a feature request or minor typo in the one of the pages.
- Medium
- The request has moderate priory such as a typo affecting a feature or bug in a non-critical system.
- High
- The request has high priory, for bugs or issues effecting major critical systems (ie simulations, assignments, auth) or site -wide outages.
- Click
Submit.
2.3.7 Managing Your Account
The edit profile page allows an university admin to edit their first and last name and change their password
To access the edit profile page
- Click the profile icon on the right side of the navbar.
- Select
Edit Profile
2.3.7.1 Updating Your Name
- Select the input felid next to your name (first/last)
- Enter in your new name
- Click
Update
2.3.7.2 Changing Your Password
- Select the input felid next to your password
- Enter in your new password
- As a reminder please to follow the password requirements when changing your password
- Click
Update
2.4 Teacher
After logging in as a teacher you will be directed to a teacher dashboard where you can create and manage your vet classes, create, view and grade student performed vet-simulations and interact with students through the course discussion forum.
2.4.1 Classes
This page is still work in progress and therefore adding classes is not supported
The classes page will allows teachers to view, create and manage all their vet simulation courses
2.4.3 Assignments
The assignments page allows an instructor to view and manage all the class assignments/simulations for that course.
When you visit the teacher assignment page you will be presented to all active or draft assignments for the course.
Each assignment card will have the following information:
- Assignment Name
-
The name of the assignment/simulation (Ex
Assignment 1.1).
- Assignment Status
-
The viewable status of an assignment.
- Draft/Unpublished
-
The assignment has been created can only currently be viewed by you the instructor.
- Published
- The assignment is created, published and viewable by all students in the class.
- Assignment Due Date
-
The due date of this particular assignment/simulation (Ex
3/9/25).
- Assignment description
-
A brief summary of what this assignment/simulation will contain such as what animal, its difficulty, and any special conditions being tested for (Ex
Pug:Hard, fixed etc).
2.4.3.1 Creating Assignments
- Click the blue
Create Assignmentbutton on the top center of the page. - Enter the following details of the assignment:
- Assignment Name.
- Due Date2 for the assignment.
- A brief description of the assignment.
- The simulation this assignment is linked to.
- To save this assignment as a draft (unpublished ) Click
Save. - To save and publish this assignment, Click
Publish.
2.4.3.2 Editing Assignments Details
To edit the details of an existing assignment (published or draft) such as changing its due date or description: 1. Click the blue Edit button next to the assignment you wish to edit. 2. Go to the detail(s) you wish to change. 3. Click and update the input felid(s) with the desired change(s). 4. Click Save.
2.4.3.3 Making am Assignment Published
You can not change an published assignment back to draft form. To unpublish an assignment, you will no to delete the assignment and recreate it in draft form.
To change the assignment to published state: 1. Click the blue Edit button next to the assignment you wish to get published. 2. Click Publish
2.4.3.4 Deleting Assignments
Deleting an assignment is permanent. There is no way to recover a assignment once it has been deleted.
- Click the three dots on the top right of the assignment you wish to delete.
- Select
Delete - If you are sure you want to delete this assignment, click
Deleteonce more on the confirmation modal
2.4.3.5 Viewing Details
To view the details of an particular assignment, such as assignment completion or individual student performance, click the Details button on the bottom right of the assignment of interest.
On the top of the assignment details page will be an visual overview of assignment completion for the class.
Below that is an table outlining each student status and report on the assignment. Each row of the table contains:
- Name
- Name of the student for this row entry
- Completion Status
- Indication of whether is a student has completed this assignment. A green check, signals completion while a dash means unfinished.
- Graded Status
- Indication if this student’s assignment has been graded. A green check indicates the assignment has been graded, while a dash means it is ungraded.
- Student Reports
-
A link to view a individual students performance report on this simulations such as avg heart rate or response time.
N/Ameans no report for that student is available.
2.4.3.5.1 Student Performance Reports
This feature is still work in progress, some reports and/or statistics may not be available.
The reports page allows an instructor to view details statistics of an student’s performance over a particular simulation such as their average reaction time or number of mistakes.
To view a student’s report
- Go to the view details page of a particular assignment.
- Scroll to the student you would like to view the report for.
- Click the document icon to view the report for that student on this simulation.
The left portion of the report page highlights key parameters that were assessed during the simulation such as heart rate, handling of critical vitals, etc.
Beside each parameter is a indicator of the performance in that section with three possible colors:
Green/Excellent
- The student’s performance in this category was below the critical threshold of error
Amber/Acceptable
- The student’s performance in this category was at or slightly above the critical threshold of error
Red/Failed
- The student’s performance in this category was severely above the critical threshold of error
2.4.3.5.1.1 Submitting Written Feedback
In addition to viewing detailed statistics collected by the simulation on the student performance, you can also write individual feedback to each student for
To write feedback 1. Access the report of the student you would like to write feedback for 2. Type in the feedback you would like to provide to the student 3. Any previously written feedback will be inside the text box. To edit existing feedback simply make the changes to the text box 4. Click Submit Feedback to upload and save the feedback for the student to view
To return back to the assignment’s detail page, use the browser’s back button.
2.4.4 Course Grades & Code
The class grades page gives an overview of the enrolled students performance in the course.
On the top of the page gives a breakdown of the grading scale used in the course. Below that contains a table with the each students performance with the following information:
- Name
- First and last name of the student.
- Grade
-
The performance category of the student currently in based on their completed assignments/simulations. The available performance categories3 are:
- Excellent
- Proficient
- Average
- Below Average
- Needs Improvement
- Details
- A page outlining each of the students performance in each individual assignment.
2.4.4.1 Generating class codes
Only the frontend part of the page is currently operational, Please refer to adding student course for more information.
In the scores page you can also generate a course code to allow for new students to join To generate
- Go to the Score page
- Click
REGENERATE - The new course course code will display in the white box above
2.5 Student
After logging in as a student, you will be brought to the student dashboard where you can view, play around with, and complete simulation assignments, view reports on previous simulation attempts, interact with other students and instructors through discussion, provide feedback, and edit/manage your user profile.
2.5.1 Main Course Dashboard
The main course dashboard provides an overview of all the courses you are enrolled in and have added to your dashboard. Click the course to select the course to view its assignments and complete its simulation.
The details pane of the course is not implemented. Clicking it will link to the same page as the rest of the card.
2.5.1.1 Adding a Course
Currently, adding courses is only implemented in the frontend. No backend services are deployed to support adding courses to the database.
- Click
Join Class. - Enter in the access code provided to you by your instructor.
2.5.3 Assignments
The assignment page will be the first page you land on when you select a course. It gives an overview of all the available assignments in the courses, including those completed, upcoming, and available to practice.
- ToDo: A carousel of assignments that are due soon and are suggested to be completed.
- Upcoming Assignments: Assignments that are published but not due in the immediate future.
- Completed Assignments: Assignments that are completed and results (can possibly) be viewed.
2.5.3.1 Activating the Simulation Screen
- Select the button on the assignment with the number of days till due (Ex:
1 day). - Click
Start. - Wait for the simulation to load, and once loaded, refer to Simulation for how to interact with the VetSim.
2.5.4 Discussion Board
The discussion board is an interactive area where students can discuss and get help with assignments & simulations.
Sorting and filtering features will be added to future releases.
Each post displayed will have the following information:
- Author: User who wrote the post.
- Date Posted: Date-time when the post was created.
- Post Details: Paragraph(s) containing the student/instructor posts.
- Tags: Variety of different categories this post has topics related to.
- Number Of Likes: Number of users who have liked this post.
- Number of Comments: Number of replies to this post.
2.5.4.1 Generating a New Post
To create a new post:
Click
New Post.Give the new post a title.
Type in your question and topic of interest to discuss.
[Optional] You can add tags to associate this post with a category such as a particular simulation/animal.
- Click
Add Tag. - Either:
- Select from one of the preexisting tags by scrolling to it or typing and autocompleting the desired tag.
- Type in a new tag into the text entry field.
- Repeat for as many tags as desired.
- Click
Click
Post.You will be redirected back to the primary discussion page with your newly created post at the bottom of the page.
2.5.4.2 Viewing Replies
To view a reply to a post, simply click the title of the post you are interested in.
2.5.4.3 Creating a Reply
There are two ways to reply to a post:
- Click the comment button on the left side of the post.
- Expand the post comment section and click
Reply.
2.5.5 Dashboard Feedback
- Only the frontend part of this feature has been completed. Please use our Jira page to provide bug reports for the current alpha release.
- In the future, both instructors and students will have access to a feedback portal to submit feedback.
The dashboard feedback area allows students to submit bugs, new feature requests, and other feedback to system administrators and VetScientia super admin. Feedback is tracked in the form of tickets and can be created/viewed through the portal.
2.5.5.1 Creating a New Feedback
This feature does not save the feedback currently. An error will occur while doing so. This is actively being worked on and should be implemented by the next release.
- Click
Add Feedbackon the top right-hand corner of the page. - Type in the desired bug or feedback.
- Click
Submit Feedback.
2.5.5.2 Filtering Feedback Responses
Use the two drop-down menus on the top-left of the feedback page to filter out only relevant tickets.
Status: Filters feedback tickets by their last known status.
- Waiting for Response: The ticket has been submitted and is in a queue waiting to be processed by a university, organizational, or super admin. - In Progress: The ticket has been seen, and a fix is actively being worked on. - Resolved: The requested issue has been resolved.Topic: The topic this feedback ticket is related to (Ex:
Simulations).
Once the wanted filters have been selected, click Search to apply the filters.
To clear the filters, click Clear Filters.
3 Simulation
3.1 Using the Simulator
Test out using the simulation with Vet Scientia Demo.
To focus on the animal, click the animal.
To check the animal’s vitals, focus on the animal and then hover over the animal. You will see a popup of the vitals like heart rate and respiratory rate.
To exit focus on any object, click the back button located towards the bottom of the screen.
To examine the drugs, click the cabinet on the left.
To look at the name of a drug, hover over the drug.
To equip a drug, click the drug bottle.
To get a short description of the drug, click the thumbnail of the drug.
To apply a drug to the animal, equip the drug, focus on the animal, and then click the animal. The drug thumbnail should disappear.